home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK1.toast / Development Kits (Disc 1) / Apple Game Sprockets / InputSprocket 1.0.1 / InputSprocket Release Notes < prev    next >
Encoding:
Text File  |  1996-09-12  |  4.1 KB  |  110 lines  |  [TEXT/CWIE]
  1. InputSprocket 1.0
  2. Release Notes
  3. -----------------
  4.  
  5. Please report all bugs to sprockets@adr.apple.com!
  6.  
  7. Release Components
  8. ------------------
  9.  
  10. InputSprocket Release Notes                - this file
  11. InputSprocket.h                            - the header file to compile with
  12. InputSprocketLib                        - release version of the library
  13. InputSprocketDebugLib                    - debugging version of the library
  14. InputSprocketStubLib                    - version of the library to link to
  15. InputSprocket Keyboard                    - keyboard plug-in
  16. InputSprocket Mouse                        - mouse plug-in
  17. InputSprocketTest                        - test program
  18. InputSprocketTest.ยต                        - Metrowerks 8 project to build test
  19. InputSprocketTest Sources                - sources for test program
  20.  
  21. Place InputSprocket Keyboard, InputSprocket Mouse and InputSprocketLib or
  22. InputSprocketDebugLib in the Extensions folder.  Place InputSprocket.h in
  23. your development environment's C Headers folder.  Place InputSprocketStubLib
  24. in your development environment's Libraries folder.
  25.  
  26. WARNING: don't place both the debugging and non-debugging versions of the
  27. library in the search path or you will not be sure which version you will be
  28. using.
  29.  
  30. Dependencies
  31. ------------
  32.  
  33. InputSprocket requires the latest Universal Headers -- version 2.1.2 or later.
  34. You can find them on E.T.O. #20, the MacOS SDK CD-ROMs, Apple's web-site, or
  35. a number of other locations.  If you have a problem with the "AbsoluteTime"
  36. type usage, then you aren't using the latest Types.h file.
  37.  
  38. Compatability with Prereleases
  39. ------------------------------
  40.  
  41. InputSprocket 1.0 is not compatible with any of the pre-release versions of
  42. InputSprocket.  You should throw out all DR versions.
  43.  
  44. Changes to 'setl' Resource
  45. --------------------------
  46.  
  47. The format for the set list resource ('setl') was changed at the last minute.
  48. A resedit TMPL resource is automatically installed in the preference file and
  49. the format is as follows:
  50.  
  51. -- header --
  52. Version                (4 bytes)        The current version is now 2.
  53. Count                (4 bytes)
  54.  
  55. -- each entry --
  56. name                (64 bytes)        A pascal string
  57. set length            (4 bytes)        The length of the set
  58. device class        (4 bytes)        The device class of the device
  59. device identifier    (4 bytes)        The device identifier of the device
  60. flags                (4 bytes)        Same flags as in the header
  61. reserved1            (4 bytes)        Reserved by apple set to zero.
  62. reserved2            (4 bytes)        Reserved by apple set to zero.
  63. reserved3            (4 bytes)        Reserved by apple set to zero.
  64. set resource id        (2 bytes)        The resource id of the set.
  65. reserved4            (2 bytes)        Reserved by apple set to zero.
  66.  
  67. Special Considerations
  68. ----------------------
  69.     
  70.     -    Your game should use the Escape key to pause and resume play.  The
  71.         element that corresponds to the Escape key is labelled
  72.         ISpElementLabel_Start.  If your game uses virtual elements then the
  73.         first button need that is labelled ISpElementLabel_Start is auto-
  74.         configured to the Escape key, and the user can't change this in
  75.         the ISpConfigure dialog.
  76.     
  77.     -    Your game may provide default and optional configurations for the
  78.         keyboard, the mouse and any other devices.  This is done by including
  79.         'setl' and 'tset' resources a resource file, such as the application's,
  80.         that is open when ISpInit and ISpConfigure are called.  Since the
  81.         format of the 'tset' resource is determined by the device, it is
  82.         easiest to use the configuration dialog to establish the desired
  83.         configurations then copy them from the Preferences file into your
  84.         resource file.
  85.         
  86.             1.    Remove the InputSprocket Preferences file from the Preferences
  87.                 folder.
  88.             
  89.             2.    Run your game, and invoke the ISpConfigure dialog.
  90.             
  91.             3.    Configure and save as many sets as you like for any and all
  92.                 devices.
  93.             
  94.             4.    Quit.
  95.             
  96.             5.    Use ResEdit to move the 'setl' and 'tset' resources to your
  97.                 resource file.
  98.             
  99.             6.    Edit the 'setl' resource using the 'TMPL' supplied in
  100.                 InputSprocketSimpleTest.rsrc.
  101.             
  102.             7.    Change the flags field to $00000002 for the default entry for
  103.                 a given device or $00000004 for any other entry for that
  104.                 device.
  105.             
  106.             8.    Again remove the InputSprocket Preferences file from the
  107.                 Preferences folder so you can test with a clean slate.
  108.             
  109.             9.    Rebuild your game and try out your new configurations.
  110.